com.highdeal.pnr.tif

Class ChargedItem

java.lang.Object

com.highdeal.pnr.tif.ChargedItem

All Implemented Interfaces:

XMLMarshallable

Direct Known Subclasses:

ResponseItem

public class ChargedItem
extends Object
implements XMLMarshallable

This class represents a charged item generated by the SAP CC system during the charging process. This data record results from the use of a customer service.

It contains:

• A numeric key
• The identifier of the related charged item class that partially specifies the configuration of the generation of charged items during the charging process
• A list of fields

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargedItem">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="chargedItemField" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
     <xs:attribute name="key" type="xs:int" use="required" />
     <xs:attribute name="chargedItemClassId" type="xs:string" use="required" />
   </xs:complexType>
 </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChargedItem.ChargedItemField This class represents a field of a charged item generated by the SAP CC system during the charging process.
static class	ChargedItem.ChargedItemFieldType This enumeration lists the possible data types for the fields contained in a charged item.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The XML tag name of this object: "chargedItem".

Constructor Summary

Constructors

Constructor and Description
ChargedItem() Builds a charged item with no charged item class identifier and no field.
ChargedItem(String chargedItemClassId, int initialFieldListSize) Builds a charged item with a charged item class identifier and no field.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getChargedItemClassId() Gets the identifier of the charged item class corresponding to the charged item.
List<ChargedItem.ChargedItemField>	getFields() Gets the list of fields of the charged item.
Integer	getKey() Gets the numeric key of the charged item.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setChargedItemClassId(String chargedItemClassId) Sets the identifier of the charged item class corresponding to the charged item.
void	setKey(Integer key) Sets the numeric key of the charged item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of this object: "chargedItem".

See Also:

Constant Field Values

Constructor Detail

ChargedItem

public ChargedItem()

Builds a charged item with no charged item class identifier and no field.

ChargedItem

public ChargedItem(String chargedItemClassId,
                   int initialFieldListSize)

Builds a charged item with a charged item class identifier and no field.

Parameters:

chargedItemClassId - The charged item class identifier of the charged item

initialFieldListSize - The initial size for the list of charged item fields

Method Detail

getKey

public Integer getKey()

Gets the numeric key of the charged item.

Returns:

The numeric key of the charged item

setKey

public void setKey(Integer key)

Sets the numeric key of the charged item.

Parameters:

key - The numeric key of the charged item

getChargedItemClassId

public String getChargedItemClassId()

Gets the identifier of the charged item class corresponding to the charged item. This configuration is available in the charge plans of the pricing catalog (master data) owned by a service provider.

Returns:

The identifier of the charged item class corresponding to the charged item

setChargedItemClassId

public void setChargedItemClassId(String chargedItemClassId)

Sets the identifier of the charged item class corresponding to the charged item.

Parameters:

chargedItemClassId - The identifier of the charged item class corresponding to the charged item

getFields

public List<ChargedItem.ChargedItemField> getFields()

Gets the list of fields of the charged item.

Returns:

The list of fields of the charged item

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into